home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Workbench Design
/
WB Collection.iso
/
workbench werkzeuge
/
disk & file tools
/
mformat
/
docs
/
mformat.eng.guide
(
.txt
)
next >
Wrap
Amigaguide Document
|
1996-04-07
|
26KB
|
508 lines
@DATABASE
@NODE MAIN "Table of Contents"
@{b}MFormat v1.6@{ub}
Copyright
1994-95
By Eric Sauvageau (Merlin)
Shareware
@{" About " LINK About}
@{" Installation " LINK Installation}
@{" GUI Interface " LINK TheInterface}
@{" Shell Interface " LINK ShellUsage}
@{" Hints " LINK MultipleFormat}
@{" Credits " LINK Credits}
@{" Disclaimer " LINK Disclaimer}
@{" Future " LINK ToDo}
@{" History " LINK History}
@ENDNODE
@NODE About "About"
MFormat is a disk formatter utility I wrote because I wasn't satisfied
with Commodore's Format command. I wanted to be able to install the disk
and to disable verifying (if I only want a quickly formatted disk for
unpacking some archive). I also wanted to be able to save my settings in a
prefs file, so I no longer have to always change the volume name to
something else than "Empty" when I get tired of that name. Finally, I
wrote MFormat because I wanted to learn to build a GUI, to use a device,
and to see how powerfull Amiga E could be. I'm not disappointed. ;)
@{" Features " LINK Features}
@{" Shareware Fee " LINK Shareware}
@ENDNODE
@NODE Features "Features"
@{b}
@{ub} Requires Kickstart 2.04 and up (support some 3.x features if
running under Kickstart 3.0 and up).
@{b}
@{ub} Can install your disks with a bootable bootblock.
@{b}
@{ub} Verify option can be turned on/off.
@{b}
@{ub} The GUI can be opened even when started from CLI.
@{b}
@{ub} Support for DC-OFS and DC-FFS when running under 3.0 and up.
@{b}
@{ub} Should be able to format any normal filesystem, including CrossDOS
(PCx:) and high density floppies.
@{b}
@{ub} Can create Disk.info and Trashcan.info icons.
@{b}
@{ub} Favorite settings can be saved in a prefs file.
@{b}
@{ub} Auto Start feature, allowing you to easily format a bunch of disks
without having to press "F" at each disks.
@{b}
@{ub} Automatic Volume Name increment option.
@{b}
@{ub} Can be opened on any public screen.
@{b}
@{ub} Device filter, to prevent any accidental HD formatting.
@ENDNODE
@NODE Shareware "Shareware fee"
If you like this program and start using it regularly, then you must send
me a Shareware fee of @{b}$10 CAN@{ub} (around $7 US). Either send cash (CAN
or US), or a postal money order to:
Eric Sauvageau
5336 10th Avenue
Montreal, Qc
Canada
H1Y-2G6.
I will also accept a registered version of a program you wrote, as an
alternative to the Shareware fee.
@{b}REMEMBER:@{ub} Support will always help a Shareware author to decide if he must
continue to improve his program, or simply throw it in the Trashcan and do
something else more usefull to him... The money received will be mainly
used to register for Amiga E 3.0, and the excess should go on other Amiga
softwares, so it will stay an investment in the Amiga community.
@ENDNODE
@NODE Installation "Installation"
Actually MFormat is very easy to install. Just drag its icon to the drawer
of your choice (usually it would be your @{b}SYS:System/@{ub} drawer). Nothing else
is required. If you want to use the 8 colors icon, just copy the
"MFormat.info" file from the @{b}8_Colors_Icon/@{ub} directory with MFormat.
You can tell MFormat to open on another public screen when ran from WB.
Just adjust the tooltype '@{b}PUBSCREEN=pubname@{ub}'.
You can also tell MFormat to not open immediately its window when runned
from Workbench, but rather to go to sleep, and add an "Awake MFormat" item
to the Workbench "Tools" menu. Just use the tooltype '@{b}MENUFY=YES@{ub}'. This
could be usefull if you want to put MFormat in your WBStartup drawer. If
you do, don't forget to also add the '@{b}DONOTWAIT@{ub}' tooltype.
Please, take the time to read this manual. A format program can be
@{b}*VERY*@{ub} dangerous if misused!
@ENDNODE
@NODE TheInterface "The Interface"
When MFormat is started from Workbench, or from the Shell with the
'@{b}GUI@{ub}' argument, a window will open, with various gadgets and some pull-down
menus that controls every aspects of MFormat. You can also press the
related hotkey to select a gadget or an option.
The window features a close gadget (in the upper left corner), and a Zoom
gadget in the right corner. Clicking on the Zoom gadget will resize the
window to the dimension of a title bar, and clicking again on it will
re-open the window at its usual dimension.
@{" Volume Name " LINK VolumeNamegadget} gadget @{" Auto Inc " LINK AutoIncrementgadget} gadget
@{" Increment " LINK Incrementgadget} gadget @{" Drives " LINK Driveslistview} listview
@{" FileSystem " LINK FileSystemgadget} gadget @{" Format " LINK Formatgadget} button
@{" Create Icons " LINK CreateIconsgadget} gadget @{" Abort " LINK Abortgadget} button
@{" Install " LINK Installgadget} gadget @{" Status " LINK Statusdisplay} display
@{" Verify " LINK Verifygadget} gadget
@{" Quick " LINK Quickgadget} gadget @{" Project " LINK ProjectMenu} pull-down
@{" Auto Start " LINK AutoStartgadget} gadget @{" Prefs " LINK PrefsMenu} pull-down
@ENDNODE
@NODE VolumeNamegadget "Volume Name gadget"
@{b}(Hotkey: 'N')@{ub}
This text gadget located at the upper left corner of the window will
contain the volume name that will be used as the disk label when the format
will be completed. By default, it is "Empty". Just click on this gadget
and type in the volume name you want (a maximum of 30 characters are
allowed). Note that you DON'T have to append a ":" at the end of the
volume's name.
@ENDNODE
@NODE Incrementgadget "Increment counter gadget"
@{b}(Hotkey: 'M')@{ub}
This integer gadget is located to the right of the Volume Name gadget.
Ghosted if the @{" Auto Inc " LINK AutoIncrementgadget} gadget isn't checked, this gadget will act as
a counter. When formatting with the "Auto Inc" feature turned on, this
value will be appended to the Volume Name, and incremented by one when the
formatting is finished. You can adjust this value as you wish, by clicking
on this gadget, and entering any value from 0 to 9999.
@ENDNODE
@NODE FileSystemgadget "FileSystem gadget"
@{b}(Hotkey: 'S')@{ub}
Clicking on this cycle gadget will let you select which file system you
want to use for the disk that will be formatted. The available file systems
@{b}- OFS@{ub} (OldFileSystem, compatible with any Kickstart version)
(drive/partition with a capacity smaller than 52 Mb)
@{b}- FFS@{ub} (FastFileSystem, compatible with Kickstart 2.0 and up)
@{b}- INT-OFS@{ub} (International OldFileSystem, compatible with Kick 2.0 and up)
@{b}- INT-FFS@{ub} (International FastFileSystem, compatible with Kick 2.0 and up)
@{b}- DC-OFS@{ub} (DiskCache OldFileSystem, only available on Kick 3.0 and up)
@{b}- DC-FFS@{ub} (DiskCache FastFileSystem, only available on Kick 3.0 and up)
This gadget will be unavailable when formatting a CrossDOSS device
(like PC0: or PC1:).
@{b}Note:@{ub} When formatting an alien device, check the documentation. If it
doesn't specifically support one of these filesystems (like a CP/M
or Mac filesystem), then leave this gadget on "OFS".
@ENDNODE
@NODE CreateIconsgadget "Create Icons gadget"
@{b}(Hotkey: 'C')@{ub}
Clicking on this gadget will enable/disable the creation of the Disk.info
and the Trashcan icons when formatting. Checking this box will enable this
feature.
@ENDNODE
@NODE Installgadget "Install gadget"
@{b}(Hotkey: 'I')@{ub}
Clicking on this gadget will tell MFormat if it should install a bootable
bootblock on the disk. Checking this box will enable this feature. This
gadget will only available when formatting a drive controlled by the
trackdisk.device (that is, a DFx: floppy drive).
@ENDNODE
@NODE Verifygadget "Verify gadget"
@{b}(Hotkey: 'V')@{ub}
Clicking on this gadget will tell MFormat if it should verify each
formatted track. It is safer to leave this option turned "ON", unless you
want your disk to be formatted faster, but at the risk of having some errors
on your disk if it is bad. This gadget will be ghosted if you have selected
the @{" Quick " LINK Quickgadget} option (since it only applies to whole disk
formatting).
@ENDNODE
@NODE Quickgadget "Quick gadget"
@{b}(Hotkey: 'Q')@{ub}
Clicking on this gadget will tell MFormat if it should format the whole
disk or only re-initialize (Quick Format) it. Only enable this option if you
are re-initializing an already formatted disk.
@ENDNODE
@NODE AutoStartgadget "Auto Start gadget"
@{b}(Hotkey: 'A')@{ub}
Clicking on this gadget will enable/disable the auto-formatting. When
this option is turned on, MFormat will check the drive currently selected in
the drive list. As soon a disk will be inserted in that drive, it will
format it (giving you 5 seconds to either click on the "Abort" gadget or
press "A" key to cancel formatting). When you will select this feature, a
requester will appear, reminding you to be cautious with the Auto Start
feature enabled.
@ENDNODE
@NODE AutoIncrementgadget "Auto Inc gadget"
@{b}(Hotkey: 'U')@{ub}
Clicking on this gadget will enable/disable the auto volume name
increment. If you use this feature, the Increment Counter value will be
appended to the volume name, and the counter will be incremented by one
after each formatting. That will give you, by example: "Empty1, Empty2,
Empty3, ... ,Empty10, Empty11" and so on.
@ENDNODE
@NODE Driveslistview "Drives listview"
@{b}(Hotkey: 'D')@{ub}
This small window will display the available devices that you can
format. Just click on the device you want to format. Some informations
about the selected device will appear just above the Status gadget, showing
you the volume name (if there's one in the drive) and its total storage
capacity.
When in Auto Start mode, you must select here the device you want to be
monitored by MFormat for disk insertions.
Just to the right of this small window you'll find a small button
with an "R" written on it. Clicking on this button will update the
Drives listview, in case you just mounted some new device.
@ENDNODE
@NODE Formatgadget "Format button"
@{b}(Hotkey: 'F')@{ub}
This gadget will start the format. MFormat will ask you then if you are
really sure that you want to format the selected device, or if you want to
abort it, having changed your mind. Remember: @{b}ANY data will be LOST@{ub} when
you start to format a device! You can still abort it after it has begun,
but all tracks already formatted by then will be lost forever.
This gadget won't be available if no disk is present in the selected
drive.
@ENDNODE
@NODE Abortgadget "Abort button"
@{b}(Hotkey: 'A')@{ub}
This gadget will only be available while formatting, and during the
"Countdown To Doom" in Auto Start mode (you will have five seconds to abort
an auto-format). Clicking on this gadget will give you the possibility to
abort an on-going formatting.
@ENDNODE
@NODE Statusdisplay "Status display"
This text area will display the current status of MFormat. Any error
encountered by MFormat will also be displayed there. You can't do anything
with this gadget except just stare at it, and smile :)
Just above there's another text area that will display informations about
the device currently selected, such as the volume name of the disk
currently in the selected drive (if there's one), and the total storage
capacity possible on this device.
@ENDNODE
@NODE ProjectMenu "Project Menu"
In this menu, you will find three items:
@{b}"About..."@{ub} will give you some general infos about MFormat.
@{b}"Sleep..."@{ub} will close MFormat's window, and add a new item to the
Workbench's "Tools" menu. This new item will allow you to re-open the
window.
@{b}"Quit"@{ub} will exit MFormat (just like clicking on the close gadget).
@ENDNODE
@NODE PrefsMenu "Prefs Menu"
In this menu, you'll find the following items:
@{b}"Filter List..."@{ub} will open the @{" Device Filtering List " LINK FilterListWindow} window.
@{b}"Load Prefs"@{ub} will load the last saved config file in ENV: and adjust your
settings according to this preferences file.
@{b}"Save Prefs"@{ub} will save the current options, selected filesystem and
volume name to "ENV:MFormat.prefs" and "ENVARC:MFormat.prefs". This prefs
file will be loaded each time you start MFormat. Note that the "Auto
Start" option's status WON'T be saved, for safety reasons.
@{b}"Use Default"@{ub} will reset all options to their default values. That is:
Volume Name: "Empty"
FileSystem : OFS
All options: Turned Off
Increment Counter: 1
@ENDNODE
@NODE FilterListWindow "Device Filtering List window"
Most of the time, you will only format floppy disks. So, you might want
to filter some specific drives, preventing them from appearing in the Drives
listview gadget. As an example, you can filter all your hard disk
partitions so they won't show up in the Drive listview, preventing any
"regretable accident" (happened to me once... sigh...).
When MFormat is started, it will try to load the S:MFormat.filter file.
This file will contain the name of the drives you don't want to appear in
the Drives list on the MFormat's main window. Don't edit it yourself!
When MFormat will scan your system for available drives, any drive matching
whose name is found on this filter list won't be displayed in the Drives
listview.
This window allow you to add or remove drives from this filter list:
@{b}Add a device:@{ub} Click in the String gadget, and enter the device name
you want to add to the Filtered list (like DH0: or CC0:). Then, click on
the "@{b}Add@{ub}" button.
@{b}Delete a device:@{ub} Click on the device to remove from the list in the
Filtered list, and then click on the "@{b}Del@{ub}" button.
When you have finished editing the filter list, just click on the "@{b}OK@{ub}"
button. If you made any changes to the list, the filter list will be
saved to disk in the @{b}S:MFormat.filter@{ub} file, and the device list will be
rescanned, updating the Drives listview gadget.
@ENDNODE
@NODE ShellUsage "Shell Usage"
MFormat can be started from the Shell. Doing @{b}MFormat ? @{ub} will show the
command template:
@{b}MFormat v1.6 -
1994-95 by Eric Sauvageau (Merlin).@{ub}
D=DRIVE/K,N=NAME/K,FS/K,Q=QUICK/S,V=VERIFY/S,IC=ICONS/S,IN=INSTALL/S,G=GUI/S,
P=PUBSCREEN/K,M=MENUFY/S:
You can use either the full names or the shortcuts when entering
parameters.
By default, entering MFormat without any argument will open the window
interface.
@{" DRIVE " LINK Shell_Drive} @{" ICONS " LINK Shell_Icons}
@{" NAME " LINK Shell_Name} @{" INSTALL " LINK Shell_Install}
@{" FS " LINK Shell_FS} @{" GUI " LINK Shell_GUI}
@{" QUICK " LINK Shell_Quick} @{" PUBSCREEN " LINK Shell_Pubscreen}
@{" VERIFY " LINK Shell_Verify} @{" MENUFY " LINK Shell_Menufy}
@{b}Examples:@{ub}
8.System3.0> MFormat D df0: N Empty FS ffs
Will format disk in DF0: with the volume name "Empty, and will use
FastFileSystem.
8.System3.0> MFormat Drive=df1: n=Archives fs=dcffs v p=term
Will format disk in DF1: with the volume name "Archives", and will use the
DiskCache FFS. MFormat will verify the formatting, and the output window
will be opened on the public screen "term".
@ENDNODE
@NODE Shell_Drive "Shell Usage: Drive"
@{b}(Shortcut: 'D')@{ub}
This is the device you wish to format.
@{b}Examples:@{ub} DRIVE DF0:
D PC1:
@ENDNODE
@NODE Shell_Name "Shell Usage: Name"
@{b}(Shortcut: 'N')@{ub}
This is the volume name you wish to give to the formatted drive. Do NOT
append any ':' to it.
@{b}Examples:@{ub} NAME DataDisk
N Empty
@ENDNODE
@NODE Shell_FS "Shell Usage: FS"
@{b}(Shortcut: none)@{ub}
This is the filesystem you want to use. The available arguments are:
@{b}OFS@{ub} - Old File System
@{b}FFS@{ub} - Fast File System
@{b}IOFS@{ub} - Old File System (International)
@{b}IFFS@{ub} - Fast File System (International)
@{b}DCOFS@{ub} - Disk Cache Old File System (OS 3.x only)
@{b}DCFFS@{ub} - Disk Cache Fast File System (OS 3.x only)
@{b}Examples:@{ub} FS ffs
FS=iffs
@{b}See Also:@{ub} @{" FileSystem gadget " LINK FileSystemGadget}.
@ENDNODE
@NODE Shell_Quick "Shell Usage: Quick"
@{b}(Shortcut: 'Q')@{ub}
Boolean flag. Just add this keyword if you wish to re-initialize the
disk, without re-formatting every cylinders.
@{b}See Also:@{ub} @{" Quick gadget " LINK Quickgadget}.
@ENDNODE
@NODE Shell_Verify "Shell Usage: Verify"
@{b}(Shortcut: 'V')@{ub}
Boolean flag. Add this keyword if you wish MFormat to verify every
cylinders after formatting it.
@{b}See Also:@{ub} @{" Verify gadget " LINK Verifygadget}.
@ENDNODE
@NODE Shell_Icons "Shell Usage: Icons"
@{b}(Shortcut: 'IC')@{ub}
Boolean flag. Add this keyword if you wish MFormat to create the Trashcan
and the Disk.info icon.
@ENDNODE
@NODE Shell_Install "Shell Usage: Install"
@{b}(Shortcut: 'IN')@{ub}
Boolean flag. Add this keyword if you wish to put a bootable bootblock on
the disk.
@{b}See Also:@{ub} @{" Install gadget " LINK Installgadget}.
@ENDNODE
@NODE Shell_Gui "Shell Usage: GUI"
@{b}(Shortcut: 'G')@{ub}
Boolean flag. Put this keyword if you wish to open the Graphical User
Interface (GUI). When you use this keyword, all other keywords will be
ignored, excepted for the @{" Pubscreen " LINK Shell_Pubscreen} keyword.
@ENDNODE
@NODE Shell_Pubscreen "Shell Usage: PublicScreen"
@{b}(Shortcut: 'P')@{ub}
If you want MFormat to open the GUI or the output window on another
screen than the Workbench, enter the public screen name here (case
sensitive).
If the public screen cannot be found, then the window will open on the
Workbench.
@{b}Examples:@{ub} PUBLICSCREEN term
P MyPubScreen
@ENDNODE
@NODE Shell_Menufy "Shell Usage: Menufy"
@{b}(Shortcut: 'M')@{ub}
If you want MFormat to close its window and add an "Awake MFormat" item
to the Workbench's "Tools" menu, use this boolean switch. MFormat won't
open its window until you select "Awake MFormat" in the Tools menu.
Using this switch will work like if you had also added the "GUI" switch.
@ENDNODE
@NODE MultipleFormat "Hint: Format two disks at the same time."
You want to format two disks at a same time? That's simple: just start
two MFormats, and format a different device with each of them! Did you
forgot that you were using a multi-tasking computer? :)
@ENDNODE
@NODE Credits "Credits"
MFormat was compiled with Amiga E 2.1b (V39 patched). The GUI was
generated using GadToolsBox 2.0c and SrcGen 0.4.
Thanks to:
-Yanik Grignon, R
tourneau, Scott Pinard and
a few others for beta-testing.
-Amiga for a great machine (this A1200 of mine!).
-Wouter van Oortmerssen , for Amiga E and SrcGen 0.4.
-Jabba Development for GadToolsbox 2.0c.
I can be reached on this BBS where I'm the Co-Sysop:
@{b}PowerLand BBS@{ub}
Rosemere, Qc (Canada)
Node 1: 1-514-965-7295 (V32bis)
Node 2: 1-514-965-8954 (2400)
Fidonet 1:242/907.0
Or from Internet at: Eric.Sauvageau@f907.n242.z1.fidonet.org
Also, thanks to those who sent the shareware fee (one so far...):
-Jon B. Peterson (USA)
@ENDNODE
@NODE Disclaimer "Disclaimer"
This software is provided "as is". I'm not responsible of any problem
you may encounter while using this software or any other files included in
this package. You are using it at your own risks.
This archive can be freely distributed, as long as all included files
remains unmodified. The whole archive and the files included in it are
Copyright
1994-95 by Eric Sauvageau.
Even if this software has been tested thoroughly, some bug can still
exist in it. If you found one, just send me a netmail on Fido 1:242/907.0
about it so I can fix it for a future update.
If you are using this program on a regular basis, then you MUST pay the
Shareware fee. Remember that supporting software authors is the best way to
support @{b}YOUR@{ub} Amiga.
@ENDNODE
@NODE ToDo "To Do"
These are a partial list of things that could be added in a later update
of MFormat (if the support is good enough...)
Localisation?
Allow to save multiple prefs files, so you could have one with a given
name and a given increment counter, another one with a different name,
etc...
@ENDNODE
@NODE History "History"
@{b}1.0 (12-Jan-94)@{ub}
- First public release.
@{b}1.1 (22-June-94) Recompiled using V39 modules & EC 2.1b Patch v39.@{ub}
- Finally hard disk support! (And by the same, support any device,
like the diskspare.device, hackdisk.device, etc...)
- Added a progress bar.
- Disable menus while formatting.
- Added Auto Incrementing volume name option.
- Added blocksize sniffing (now support devices with blocksize
different than 512 bytes)
- Code optimization in the window init (~600 bytes saved).
- "FileSystem" gadget enabled for all devices. Be cautious when
formatting something else than an AmigaDOS device: always use
OFS for these, unless the device's documentation say you
can change it.
- "Create Icons" will be usable for ANY kind of devices now.
- "Install" will be usable ONLY for trackdisk.device (DFx:).
- "Format" gadget disabled if no disk in drive.
- Readjusted some gadget sizes.
- Added a 4 colors icon, and moved the 8 colors icon in a
separate drawer.
- Will correctly detect the absence/presence of a CrossDOS disk.
- Changed "(No Dos)" by "(Unreadable)" - makes more sense for
non-AmigaDOS filesystems.
@{b}1.2 (23-June-94)@{ub}
- Fixed bug with large fonts.
@{b}1.3 (17-Sep-94)@{ub}
- New prefs file format. Save your prefs over the older ones.
- CLI interface added.
- Added "Sleep..." menu item and MENUFY tooltype.
- Added PUBSCREEN tooltype and full public screen support.
- Now, AutoStart only starts if a disk is inserted in the currently
selected device. That fixed the problem with multiple
filesystems on a single physical drive.
- Complete re-write of the Auto Increment function. Now
usable anytime.
- Re-wrote the device scan and list building routine. Fixes
ArcHandler and some other quirks.
- Now checks for invalid chars in the volume name.
- Previous versions contained a kludge to avoid a bug present in
diskspare.device v1.6. Since v2.0 had this bug solved, I removed
the workaround. So if MFormat crashes/fails to format a
DSx: device, be sure you upgrade your diskspare.device to v2.0.
- Sometime, a volume would get formatted TWICE when in Auto Start
mode. Now fixed.
- Code optimisation, and removal of some hardcoded limits.
@{b}1.4 (2-Nov-94)@{ub}
- BUG FIXED: When formatting a partition on an hard disk that
was located somewhere in the middle of the HD, the progress bar
wouldn't be starting from the beginning.
- BUG FIXED: Will no longer give you some bogus requester "Are you
sure you want to format it? (xxxMB)?" when you try to format a
floppy under some conditions (I forgot to clear a variable
somewhere).
@{b}1.5 (14-Jan-95)@{ub}
- NEW: Filter list window. Allow you to filter the Devices list
so filtered devices won't appear in the Devices window, and will
prevent any "accident" with those devices (like HD partitions).
- NEW: Added a "R"escan button, allowing to update the Devices list.
- BUG FIXED: In a particular situation, the public screen wouldn't
be unlocked when using MFormat's Shell interface.
- BUG FIXED: No longer lose memory after each Awake. That memory
was released at exit time, now it is released at Awakening.
- Device List now sorted by alphabetical order.
- Now, disks not completely formatted (error or aborted) will
show up as "????" rather than "NODOS" on Workbench.
- During startup, any invalid device will simply be ignored,
rather than aborting with "Cannot init device!". Will solve
problems for those mounting PC1: when DF1: isn't present, etc...
- Improved hotkeys handling:
Shift-S will cycle the FileSystem gadget selection backward.
Shift-D will select the previous device in the list.
- Some internal cleanup around various features.
- Improved error handling around prefs files.
- Improved Shell interface.
@{b}1.6 (26-Jan-95)@{ub}
- BUG FIXED: Filter List wouldn't be properly loaded on some
occasions.
"What do you mean, "I don't believe in God"?
I talk to him everyday!"
-Megadeth
-----
@ENDNODE